home *** CD-ROM | disk | FTP | other *** search
/ AOL File Library: 2,801 to 2,900 / aol-file-protocol-4400-2801-to-2900.zip / AOLDLs / C++ Files Library / Point_Rect C++ Classes / MacObj.sit / MacObj ƒ / CRect.note < prev    next >
Text File  |  1993-09-15  |  4KB  |  129 lines
  1. class CRect : public Rect
  2.  
  3. The CRect class is based on the Macintosh Rect structure and includes
  4. methods that operate on CRect and Rect structures.  A CRect object can
  5. be used wherever a Rect structure is used.
  6.  
  7. The Macintosh Rect structure is defined as:
  8.  
  9. struct Rect {
  10.  short top;
  11.  short left;
  12.  short bottom;
  13.  short right;
  14. };
  15.  
  16. To use this class include the header file CRect.h.
  17.  
  18. Constructors:
  19.  
  20.     CRect();
  21.         Constructs a CRect object.  Members are not initialized.
  22.         
  23.     CRect(short l, short t, short r, short b);
  24.         Constructs a CRect object.  Members left, top, right, bottom are initialized
  25.         to l, t, r, b respectively.
  26.          
  27.     CRect(const Rect& r);
  28.         Constructs a CRect object.  Members a initialized to the corresponding values
  29.         of Rect r.
  30.  
  31. Member functions:
  32.  
  33.     void SetRect(short l, short t, short r, short b);
  34.         Sets the dimensions of CRect to the specified values.
  35.         
  36.     void SetRectEmpty();
  37.         Sets all coordinates to 0.
  38.  
  39.     void InsetRect(short x, short y);
  40.         Shrinks or expands the CRect by the specified distance.
  41.  
  42.     void OffsetRect(short x, short y);
  43.         Moves the CRect horizontally and vertically by the specified distance.
  44.         
  45.     void OffsetRect(Point p);
  46.         Moves the CRect horizontally and vertically by values specified 
  47.         in point p.
  48.  
  49.     Boolean PtInRect(Point p);
  50.         Returns true if Point p is enclosed by CRect.
  51.         
  52.     Boolean EmptyRect() const;
  53.         Returns true if CRect is empty.  CRect is empty if either its height or width
  54.         is 0 or less.
  55.         
  56.     Boolean NullRect() const;
  57.         Returns true if CRect is null.  CRect is null if all coordinates are 0.
  58.         
  59.     short Height(void);
  60.         Returns the height of CRect.  The height is the distance between the top and
  61.         bottom borders.
  62.         
  63.     short Width(void);
  64.         Returns the width of CRect.  The width is the distance between the left and
  65.         right borders.
  66.         
  67.     Boolean EqualRect(const Rect& r) const;
  68.         Returns true if the coordinates of CRect and r are equal.
  69.         
  70.     CPoint& TopLeft();
  71.         Returns the top and left coordinates of CRect as a CPoint.
  72.         
  73.     CPoint& BottomRight();
  74.         Returns the bottom and right coordinates of CRect as a CPoint.
  75.  
  76.     void UnionRect(Rect& r1, Rect& r2);
  77.         Sets CRect to the smallest rectangle enclosing both r1 and r2.
  78.  
  79.     void SectRect(Rect& r1, Rect& r2);
  80.         Sets CRect to the intersection of r1 and r2.
  81.  
  82.     void EraseRect();
  83.         Quickdraw EraseRect.  Fills CRect with the background pattern.
  84.         
  85.     void FillRect(PatPtr thePat);
  86.         Quickdraw FillRect.  Fills CRect with the specified pattern.
  87.         
  88.     void FrameRect();
  89.         Quickdraw FrameRect.  Draws the outline of CRect.
  90.         
  91.     void InvertRect();
  92.         Quickdraw InvertRect.  Inverts all pixels enclosed by CRect.
  93.         
  94. Operators:
  95.  
  96.     void operator=(const Rect& r);
  97.         Sets the coordinates of CRect to the corresponding values of Rect r.
  98.         
  99.     Boolean operator==(const Rect& r) const;
  100.         Returns true if CRect is equal to r.
  101.  
  102.     Boolean operator!=(const Rect& r) const;
  103.         Returns true if CRect is not equal to r.
  104.  
  105.     void operator+=(Point p);
  106.         Offsets CRect by p.
  107.         
  108.     void operator-=(Point p);
  109.         Offsets CRect by negative p.
  110.     
  111.     void operator|=(const Rect& r);
  112.         Sets CRect to the union of CRect and r.
  113.  
  114.     void operator&=(const Rect& r);
  115.         Sets CRect to the intersection of CRect and r.
  116.  
  117.     CRect operator+(Point p) const;
  118.         Returns a CRect that is offset by p.
  119.  
  120.     CRect operator-(Point p) const;
  121.         Returns a CRect that is offset by negative p.
  122.  
  123.     CRect operator|(const Rect& r) const;
  124.         Returns a CRect that is the union of CRect and r.
  125.  
  126.     CRect operator&(const Rect& r) const;
  127.         Returns a CRect that is the intersection of CRect and r.
  128.         
  129.